home *** CD-ROM | disk | FTP | other *** search
/ MacTech 1 to 12 / MacTech-vol-1-12.toast / Source / SAT 2.4.0 & updates ƒ / SAT 2.4.0 ƒ / SAT CW Lib ƒ / SAT.h < prev    next >
Text File  |  1997-02-21  |  11KB  |  291 lines
  1. /* #include file for SAT */
  2.  
  3. #ifndef __SAT__
  4.  
  5. #define __SAT__
  6.  
  7. #pragma once
  8. #ifdef __cplusplus
  9. extern "C" {
  10. #endif
  11.  
  12. #pragma options align=mac68k
  13.  
  14. #ifndef true
  15. #define true 1
  16. #endif
  17.  
  18. #ifndef false
  19. #define false 0
  20. #endif
  21.  
  22. #ifndef nil
  23. #define nil 0L
  24. #endif
  25.  
  26.     typedef struct SATPort {
  27.         GrafPtr        port;
  28.         GDHandle    device;
  29.         Ptr                rows;
  30.         Rect            bounds;
  31.         Ptr                baseAddr;
  32.         short            rowBytes;
  33.     } SATPort;
  34.  
  35.     typedef struct Face {
  36.         char            *colorData;
  37.         short            resNum;
  38.         BitMap            iconMask;
  39.         short            rowBytes; /* Note! No flags in the highest bits!*/
  40.         struct face        *next;
  41.         RgnHandle        maskRgn;
  42.         Ptr    rows, maskRows;
  43.         pascal void (*redrawProc)(struct Face *, short);    //Called on depth changes, not needed if the face is loaded from a cicn}
  44.         pascal void (*drawProc)(struct Face *, RgnHandle, SATPort *, Point srcPt, Point dstPt, short width, short height); // Untested from C so far!
  45.         } Face, *FacePtr;
  46.  
  47.  
  48.     typedef struct Sprite {
  49. /* Variables that you should change as appropriate */
  50.         short            kind;
  51.         Point            position;
  52.         Rect            hotRect, hotRect2;    // Only change hotRect, SAT handles hotRect2
  53.         FacePtr            face;
  54.         pascal void        (*task) (struct Sprite *);
  55.         pascal void        (*hitTask) (struct Sprite *, struct Sprite *);
  56.         pascal void        (*destructTask) (struct Sprite *);
  57.         RgnHandle        clip; /* Clip region to be used when this sprite is drawn. */
  58. /* SAT variables that you shouldn't change: */
  59.         Point            oldpos;
  60.         struct Sprite    *next, *prev;
  61.         Rect            r, oldr;
  62.         FacePtr        oldFace;            //Used by RunSAT2
  63.         Boolean        dirty;        //Used by RunSAT2
  64. /* Variables for free use by the application: */
  65.         short        layer;
  66. #ifdef SATCPP_H
  67.       Ptr            spriteBegin;
  68. #else
  69.         Point            speed;
  70.         short        mode;
  71.         Ptr            appPtr;
  72.         long            appLong;
  73. #endif
  74.         } Sprite, *SpritePtr;
  75.  
  76.  
  77. typedef struct{
  78.         short    patternType;     /* 1 = Pattern, PatHandle, 2 = PixPat, PixPatHandle */
  79.         PixPatHandle    thePat;         /* or PatHandle */
  80.         }    SATPattern, *SATPatPtr, **SATPatHandle;
  81.  
  82. #define    UpdatePtr    Ptr
  83.  
  84. typedef struct {
  85.         SATPort        wind;
  86.         short            offSizeH, offSizeV;
  87.         SATPort        offScreen, backScreen;
  88.         long            ox, oy;
  89.         short            pict, bwpict;
  90.         Boolean        fitThePICTs;
  91.         short            sorting, collision, searchWidth;
  92.         PixMapHandle    screen;
  93.         Rect            bounds;
  94.         short            initDepth;
  95.         pascal Boolean    (*synchHook) ();
  96.         SpritePtr        sRoot;
  97.         UpdatePtr        updateRoot;
  98.         Boolean        anyMonsters;
  99.  
  100.         CGrafPtr        ditherOff;
  101.         GDHandle        ditherOffGD;
  102.         SATPort            iconPort;
  103.         SATPort            iconPort2;
  104.         GrafPtr            bwIconPort;
  105.  
  106. /* Environment-independent globals: */
  107.         FacePtr            faceRoot;    /* Face list */
  108.         Boolean            colorFlag; /* Is this Mac color capable? */
  109. /*Blitters! You should not change these fields yourself. (Possibly for installing a blitter in your program code.)*/
  110.         ProcPtr    rectBlit1, maskBlit1;                //{Supplied - this is either RBlt/MBlt 0 or 1}
  111.         ProcPtr    rectBlit2, maskBlit2;                //{Will probably never be used}
  112.         ProcPtr    rectBlit4, maskBlit4;                //{Supplied}
  113.         ProcPtr    rectBlit8, maskBlit8;                //{Supplied}
  114.         ProcPtr    rectBlit16, maskBlit16;            //{Not supplied}
  115.         ProcPtr    rectBlit32, maskBlit32;            //{Not supplied}
  116.         ProcPtr    curRectBlit, curMaskBlit;        //{Currently selected fast blitter}
  117.  
  118.         Rect    screenLocalDrawingArea;
  119.         SpritePtr    trashList;
  120.         } SATglobalsRec;
  121.  
  122. /* Constants for SATConfigure */
  123.     enum{kVPositionSort=0, kLayerSort, kNoSort};
  124.     enum{kKindCollision=0, kForwardCollision, kBackwardCollision, kNoCollision, kForwardOneCollision};
  125.  
  126. // For CodeWarrior C, 68k (due to capitalization problems):
  127. // Note: If you have link problems associated with gSAT, you may have
  128. // to activate or deactivate this #define!
  129. #ifdef __MWERKS__
  130. #ifndef powerc
  131. #define gSAT GSAT
  132. #endif
  133. #endif
  134.  
  135. /* Global variables */
  136.     extern SATglobalsRec    gSAT;    /* Most globals */
  137.     extern pascal void        (*gSoundErrorProc)(OSErr); /* Sound errors reported here */
  138.  
  139. /* SAT routines */
  140.  
  141.     typedef pascal void (*TaskPtr)(SpritePtr);
  142.     typedef pascal Boolean (*SynchPtr)(void);
  143.     typedef pascal void (*EmergencyPtr)(void);
  144.  
  145. /* Initialization */
  146.     pascal void SATConfigure(Boolean, short, short, short);
  147.     pascal void SATInit (short, short, short, short);
  148.     pascal void SATCustomInit (short, short, Rect *, WindowPtr, GDHandle, Boolean, Boolean, Boolean, Boolean, Boolean);
  149. /* Maintainance, background manipulation etc. */
  150.     pascal Boolean SATDepthChangeTest(void);
  151.     pascal void SATDrawPICTs (short, short);
  152.     pascal void SATRedraw(void);
  153. /* Drawing */
  154.     pascal void SATPlotFace(FacePtr, SATPort*, Point, Boolean); /*Draw a Face (icon).*/
  155.     pascal void SATPlotFaceToScreen(FacePtr, Point, Boolean);
  156.     pascal void SATCopyBits(SATPort*, SATPort*, GDHandle, Rect*, Rect*, Boolean);
  157.     pascal void SATCopyBitsToScreen(SATPort*, Rect*, Rect*, Boolean);
  158.     pascal void SATBackChanged (Rect *); /*Tell SAT about changes in BackScreen*/
  159. /* SetPort replacements */
  160.     pascal void SATGetPort (SATPort*);
  161.     pascal void SATSetPort (SATPort*);
  162.     pascal void SATSetPortOffScreen(void); /*Use before Quick-Drawing on offScreen*/
  163.     pascal void SATSetPortBackScreen(void); /*Use before Quick-Drawing on BackScreen*/
  164.     pascal void SATSetPortScreen(void); /*Use to restore after drawing off/backscreen*/
  165. /* Sprite handling */
  166.     pascal FacePtr SATGetFace (short);
  167.     pascal void SATDisposeFace (FacePtr);
  168.     pascal SpritePtr SATNewSprite (short,short,short, TaskPtr); // (*void)(SpritePtr));
  169.     pascal SpritePtr SATNewSpriteAfter (SpritePtr,short,short,short, TaskPtr);
  170.     pascal void SATKillSprite (SpritePtr);
  171. /* Animating */
  172.     pascal void SATRun (Boolean);
  173.     pascal void    SATRun2 (Boolean); //Alternate routine for allowing resting sprites}
  174. /* Advanced special-purpose calls */
  175.     pascal void SATInstallSynch (SynchPtr);
  176.     pascal void SATInstallEmergency (EmergencyPtr);
  177.     pascal void SATSetSpriteRecSize (long);
  178.     pascal void SATSkip(void);
  179.     pascal void SATKill(void); /*Dispose of offscreen buffers to allow re-init*/
  180.     pascal void SATWindMoved(void);            /* For programs with moveable animation window and fast animation */
  181. /* Offscreen - use only if you need an *extra* offscreen buffer. These calls are likely to change in the future!*/
  182.     pascal void SATMakeOffscreen (SATPort*, Rect*);    /*Make offscreen buffer in current screen depth and CLUT.*/
  183.     pascal void SATDisposeOffScreen (SATPort*);        /*Get rid of offscreen*/
  184.     pascal OSErr CreateOffScreen (Rect*, short, CTabHandle, CGrafPtr*, GDHandle*); /*From Principia Offscreen*/
  185.     pascal void DisposeOffScreen (CGrafPtr, GDHandle);            /*From Principia Offscreen*/
  186. /* Face manipulation */
  187.     pascal void SATSetPortMask (FacePtr);
  188.     pascal void SATSetPortFace (FacePtr);
  189.     pascal void SATSetPortFace2 (FacePtr);
  190.     pascal FacePtr SATNewFace (Rect*);
  191.     pascal void SATChangedFace (FacePtr);
  192.  
  193. /* Most common old names, uncomment for compatibility with old programs */
  194. // #define ConfigureSAT        SATConfigure
  195. // #define InitSAT            SATInit
  196. // #define CustomInitSAT    SATCustomInit
  197. // #define KillSAT            SATKill
  198. // #define RunSAT            SATRun
  199. // #define SkipSAT            SATSkip
  200. // #define GetFace            SATGetFace
  201. // #define DisposeFace        SATDisposeFace
  202. // #define NewSprite        SATNewSprite
  203. // #define NewSpriteAfter    SATNewSpriteAfter
  204. // #define KillSprite        SATKillSprite
  205. // #define NewFace            SATNewFace
  206. // #define ChangedFace        SATChangedFace
  207. // #define PeekOffscreen    SATRedraw
  208.  
  209. // "Safe" blitter routines, using QuickDraw.
  210. pascal void SATSafeRectBlit(SATPort *srcPort, SATPort *dstPort, Rect *r);
  211. pascal void SATSafeMaskBlit(FacePtr face, SpritePtr theSprite, SATPort *dstPort, Point srcPt,Point dstPt,short width,short height);
  212.  
  213. /* New procedures, EXPERIMENTAL, intended for making a C++ interface */
  214.     pascal SpritePtr SATNewSpritePP(SpritePtr, Ptr, short, short, short, TaskPtr);
  215.     pascal void SATCopySprite(SpritePtr, const Sprite *);
  216. //    pascal void SATCopySprite(SpritePtr, SpritePtr);
  217.     pascal FacePtr SATNewFacePP(Rect*, Ptr);
  218.     pascal FacePtr SATGetFacePP (short, Ptr);
  219.     pascal void SATCopyFace(FacePtr, const Face *);
  220. //    pascal void SATCopyFace(FacePtr, FacePtr);
  221.     pascal void SATDisposeFacePP (FacePtr);
  222.  
  223. /* Cicn utilities */
  224.     pascal CIconHandle SATGetCicn (short);
  225.     pascal void SATPlotCicn (CIconHandle, GrafPtr, GDHandle, Rect*);
  226.     pascal void SATDisposeCicn (CIconHandle);
  227.  
  228. /*Utilities*/
  229.     pascal void SATSetStrings (Str255, Str255, Str255, Str255, Str255, Str255, Str255, Str255);
  230.     pascal Boolean SATTrapAvailable (short);
  231.     pascal void SATDrawInt (short);
  232.     pascal void SATDrawLong (long);
  233.     pascal short SATRand (short);
  234.     pascal short SATRand10(void);
  235.     pascal short SATRand100(void);
  236.     pascal void SATReportStr (Str255);
  237.     pascal Boolean SATQuestionStr(Str255);
  238.     pascal void CheckNoMem (Ptr); /*If the Ptr is nil, out of memory emergency exit*/
  239.     pascal short SATFakeAlert (Str255, Str255, Str255, Str255, short, short, short, Str255, Str255, Str255);
  240.     pascal void SATSetMouse (Point);
  241.     pascal void SATInitToolbox(void);
  242.     pascal void SATGetVersion(Str255 versionString);
  243. /* Pattern utilities */
  244.     pascal void SATPenPat (SATPatHandle);
  245.     pascal void SATBackPat (SATPatHandle);
  246.     pascal SATPatHandle SATGetPat (short);
  247.     pascal void SATDisposePat (SATPatHandle);
  248. /* Menu bar utilities */
  249.     pascal void SATShowMBar(WindowPtr);
  250.     pascal void SATHideMBar(WindowPtr);
  251. /* PICT utilities */
  252.     pascal void SATGetandDrawPICTRes (short id);
  253.     pascal void SATGetandDrawPICTResInRect (short id, Rect *frame);
  254.     pascal void SATGetandCenterPICTResInRect (short id, Rect *frame);
  255. /*Sound*/
  256.     pascal void SATInitSound(void);            /* No longer necessary */
  257.     pascal void SATSoundPlay (Handle, short, Boolean);    /* Play sounds with priority handling */
  258.     pascal void SATSoundShutup(void);        /*Silence, dispose of sound channel*/
  259.     pascal void SATSoundEvents(void);        /* Call this once in a while when not calling RunSAT often */
  260.     pascal Boolean SATSoundDone(void);    /* Any sound going on?*/
  261.     pascal Handle SATGetSound (short);
  262.     pascal Handle SATGetNamedSound (Str255);
  263.     pascal void SATDisposeSound (Handle);
  264.     pascal void SATSoundOn(void);
  265.     pascal void SATSoundOff(void);
  266. /* Multi-channel sound routines */
  267.     pascal short SATSoundInitChannels (short);
  268.     pascal Boolean SATSoundDoneChannel (short);
  269.     pascal void SATSoundPlayChannel (Handle, short);
  270.     pascal void SATSoundReserveChannel (short, Boolean);
  271.     pascal void SATSoundShutupChannel (short);
  272.     pascal void SATPreloadChannels(void);
  273. /* Experimental, likely to be renamed/removed/changed: */
  274.     pascal void SATSoundPlay2 (Handle, short, Boolean,Boolean);
  275.     pascal void SATSoundPlayEasy (Handle, Boolean);
  276. /* More multi-channel: */
  277.     pascal int SATGetNumChannels(void);
  278.     pascal Ptr SATGetChannel (int);
  279. /* Customization */
  280.     pascal void SATSetSoundInitParams (long);
  281. /* Step-scrolling */
  282.     pascal Boolean SATStepScroll (Point viewPoint, short marginH, short marginV, short scrollSpeed);
  283.  
  284. #pragma options align=reset
  285.  
  286. #ifdef __cplusplus
  287. }
  288. #endif
  289.  
  290. #endif
  291.